docs(networks): add versions and releases section#23319
Conversation
Adds a Versions and releases section to docs/docs/aztec/network/networks.md explaining the monorepo single-version model, the three release channels (stable, RC, nightly), the v4.next -> v4 -> RC -> stable progression, the GitHub releases changelog source, and a builder-vs-operator pinning guide. Removes the now-redundant Developer SDK vs Node Versions admonition, applies sentence-case headings and em-dash cleanup per docs/CLAUDE.md, and adds 'nightlies' to the docs cspell dictionary.
critesjosh
left a comment
There was a problem hiding this comment.
lgtm!
do you think we should say something about version compatibility on this page? e.g. minor and patch version bumps are compatible with previous versions (4.2.0 software and contracts will work with a 4.3.0 network) but major version bumps are breaking (v5 coming in summer will require app developers to upgrade)
|
@critesjosh the thing about that is that it’s not 100% strict, there might still be breaking changes in situations like that. I asked Amin about that exact scenario, and that’s what he said. |
ok nice, let's now worry about it this pr then. 🚢 |
Proposal for how
docs.aztec.network/networkslooks. The page currently lists each network's live version (e.g.4.2.0) but does not explain what that version represents, where RCs and nightlies fit, or which version a builder vs operator should pin against. This adds a concise Versions and releases section directly after the Network technical information table, and tightens the existing version note that the new section now supersedes.Targeted at the two audiences the page already serves: builders shipping on Aztec, and node / sequencer operators. The page already carries the contract-address tables, so this proposal is deliberately conservative on length: ~40 added lines for the new section, plus heading-case fixes and em-dash cleanup the docs style guide already asks for.
What changes
## Versions and releasessection covering:v4.next→ nightlies → merge tov4→ RC(s) → stable → bump;nextis parallel for v5.:::note Developer SDK vs Node Versionsadmonition near the top; its meaning is folded into the new section.docs/CLAUDE.md, and replaces em-dashes with commas / colons / parens as the style guide requires.Open questions
v4.next,v4,next) on a user-facing page. They are included because they let readers correlate this page with the GitHub releases page and the nightly tag stream; happy to drop them if too internal for a builder-facing doc.network_versioned_docs/snapshots, or only live on the next-release source.Test plan
yarnthenyarn startindocs/and verify the new section renders, anchor links resolve (#versions-and-releases,#network-selection-guide), and the channels table is readable on mobile widths.yarn spellcheckto confirm new terms (e.g.aztec.js,aztec.nr,monorepo,Testnet) are covered bydocs-words.txtor already accepted.Created by claudebox · group:
slackbot